11.8 Assoziative Speicher HashMap und TreeMap 

Java implementiert assoziativer Speicher auf zwei unterschiedlichen Arten:

• Eine übliche und sehr schnelle Implementierung ist die Hash-Tabelle (engl. hashtable), die in Java durch java.util.HashMap implementiert ist.

• Daneben existiert die Klasse java.util.TreeMap, die etwas langsamer im Zugriff ist, doch dafür alle Schlüssel sortiert. Sie sortiert die Elemente in einen Binärbaum ein.

Ein Assoziativspeicher arbeitet nur in einer Richtung schnell. Wenn etwa im Fall eines Telefonbuchs ein Name mit einer Nummer assoziiert wurde, kann die Datenstruktur die Frage nach einer Telefonnummer schnell beantworten, in die andere Richtung dauert es wesentlich länger, weil hier keine Verknüpfung besteht. Sie ist immer nur einseitig. Für wechselseitige Beziehungen sind die Klassen nicht vorbereitet.

11.8.1 Ein Objekt der Klasse HashMap erzeugen 

Die Klasse HashMap eignet sich ideal dazu, viele Elemente unsortiert zu speichern und sie über die Schlüssel schnell wieder verfügbar zu machen.

class java.util.HashMap<K,V> 
extends AbstractMap<K,V> 
implements Map<K,V>, Cloneable, Serializable

• HashMap() Erzeugt eine neue Hash-Tabelle.

• HashMap( Map<? extends K,? extends V> m ) Erzeugt eine neue Hash-Tabelle aus einer anderen Map.

11.8.2 Einfügen und Abfragen der Datenstruktur 

Wir haben gesagt, dass die Elemente der Hash-Tabelle Paare aus Schlüssel und zugehörigem Wert sind. Das Wiederfinden der Werte ist effizient nur über Schlüssel möglich.

Daten einfügen

Zum Hinzufügen von Schlüssel-Werte-Paaren dient die Methode put(). Das erste Argument ist der Schlüssel und das zweite Argument der mit dem Schlüssel zu assoziierende Wert. Der Schlüssel und der Wert können null sein.

Für Objekte, die als Schlüssel in einer Hash-Tabelle dienen sollen, müssen die Methoden hashCode() und equals() in geeigneter Weise (der Bedeutung oder Semantik des Objekts entsprechend) untereinander konsistent implementiert sein.

Map<String,String> aldiSupplier = new HashMap<String,String>(); 
aldiSupplier.put( "Carbo, spanischer Sekt", "Freixenet" ); 
aldiSupplier.put( "ibu Stapelchips", "Bahlsen Chipsletten" ); 
aldiSupplier.put( "Ko-kra Katzenfutter", "felix Katzenfutter" ); 
aldiSupplier.put( "Küchenpapier", "Zewa" ); 
aldiSupplier.put( "Nuss-Nougat-Creme", "Zentis" ); 
aldiSupplier.put( "Pommes Frites", "McCaine" );

Map<String,Number> num = new HashMap<String,Number>(); 
num.put( "zwei", 2 );    // Durch Boxing in Integer(2) 
num.put( "drei", 3.0 );  // dito. Double(3)

interface java.util.Map<K,V>

• V put( K key, V value ) Speichert den Schlüssel und den Wert in der Hash-Tabelle. Falls sich zu diesem Schlüssel schon ein Eintrag in der Hash-Tabelle befand, wird der alte Wert überschrieben und der vorherige Wert zum Schlüssel zurückgegeben. Ist der Schlüssel neu, liefert put() den Rückgabewert null. Das heißt natürlich auch, dass mit put(key, value) == null nicht klar ist, ob put() einen Wert überschreibt und der alte Wert null war, oder ob noch kein Schlüssel-Werte-Paar in dem Assoziativspeicher lag.

• void putAll( Map<? extends K, ? extends V> m ) Fügt alle Schlüssel-Werte-Paare aus m in die aktuelle Map ein. Auch diese Methode überschreibt unter Umständen vorhandene Schlüssel.

Daten auslesen

Um wieder ein Element auszulesen, verwenden wir get(key). Das Argument identifiziert das zu findende Objekt über den Schlüssel, in dem das Objekt herausgesucht wird, das den gleichen Hashwert besitzt und im Sinne von equals() gleich ist. Wenn das Objekt nicht vorhanden ist, ist die Rückgabe null. Allerdings kann auch null der mit einem Schlüssel assoziierte Wert sein, denn null ist als Wert durchaus erlaubt.

Map<String,Number> num = new HashMap<String,Number>(); 
Number number = num.get( "zwei" ); 
if ( number != null ) 
  System.out.println( number.intValue() );

interface java.util.Map<K,V>

• V get( Object key ) Liefert das mit dem entsprechenden Schlüssel verbundene Objekt. Falls kein passendes Objekt vorhanden ist, liefert die Funktion null.

Existiert der Schlüssel, existiert der Wert?

Neben get() kann auch noch mit einer anderen Funktion das Vorhandensein eines Schlüssels getestet werden: containsKey() überprüft, ob ein Schlüssel in der Tabelle vorkommt, und gibt dann ein true zurück. Die Implementierung unterscheidet sich nicht wesentlich von get().

Im Gegensatz zu get() und containsKey(), die das Auffinden eines Werts bei gegebenem Schlüssel erlauben, lässt sich auch nur nach den Werten ohne Schlüssel suchen. Dies ist allerdings wesentlich langsamer, da alle Werte der Reihe nach durchsucht werden müssen. Die Klasse bietet hierzu containsValue() an.

interface java.util.Map<K,V>

• boolean containsKey( Object key ) Liefert true, falls der Schlüssel in der Hash-Tabelle vorkommt. Den Vergleich auf Gleichheit führt HashMap mit equals() durch. Demnach sollte das zu vergleichende Objekt diese Methode aus Object passend überschreiben. hashCode() und equals() müssen miteinander konsistent sein. Aus der Gleichheit zweier Objekte unter equals() muss auch die Gleichheit ihrer hashCode()s folgen.

• boolean containsValue( Object value ) Liefert true, falls der Assoziativspeicher einen oder mehrere Werte enthält, die mit dem Objekt inhaltlich (also per equals()) übereinstimmen.

Einträge und die Map löschen

Zum Löschen eines Elements gibt es remove() und zum Löschen der gesamten Map die Funktion clear().

interface java.util.Map<K,V>

• V remove( Object key ) Löscht den Schlüssel und seinen zugehörigen Wert. Wenn der Schlüssel nicht in der Hash-Tabelle ist, so macht die Funktion nichts. Im letzten Atemzug wird noch der Wert zum Schlüssel zurückgegeben.

• void clear() Löscht die Hash-Tabelle so, dass sie keine Werte mehr enthält.

Sonstiges

Mit size() lässt sich die Anzahl der Werte in der Hash-Tabelle erfragen. isEmpty() entspricht einem size() == 0, gibt also true zurück, falls die Hash-Tabelle keine Elemente enthält. toString() liefert eine Zeichenkette, die eine Repräsentation der Hash-Tabelle zurückgibt. Die Stringrepräsentation der Hash-Tabelle liefert jeden enthaltenen Schlüssel, gefolgt von einem Gleichheitszeichen und dem zugehörigen Wert.

11.8.3 Die Bedeutung von equals(), hashCode() und IdentityHashMap 

Wenn wir Assoziativspeicher wie eine HashMap nutzen, dann sollte uns bewusst sein, dass Vergleiche nach dem Hashcode und der Gleichheit durchgeführt werden, nicht aber nach der Identität. Die folgenden Zeilen zeigen ein Beispiel:

Listing 11.14    com/javatutor/insel/util/map/HashMapAndEquals.java(), main()

Map<Point, String> map = new HashMap<Point, String>(); 
Point p1 = new Point( 10, 20 ); 
map.put( p1, "Point p1" );

Die HashMap assoziiert den Punkt p1 mit einer Zeichenkette. Was ist nun, wenn wir ein zweites Punkt-Objekt mit den gleichen Koordinaten bilden und die Map nach diesem Objekt fragen?

Point p2 = new Point( 10, 20 ); 
System.out.println( map.get( p2 ) );                    // ???

Die Antwort ist die Zeichenfolge »Point p1«. Das liegt daran, dass zunächst der Hashcode von p1 und p2 gleich ist. Des Weiteren liefert auch equals() ein true, sodass dies als ein Fund zu werten ist. (Das liefert noch einmal einen wichtigen Hinweis, dass immer beide Funktionen equals() und hashCode() in Unterklassen zu überschreiben sind.)

Mit etwas Überlegung folgt dieser Punkt fast zwangsläufig, denn bei einer Anfrage ist ja das zu erfragende Objekt nicht bekannt. Daher kann der Vergleich nur auf Gleichheit, nicht aber auf Identität stattfinden.

IdentityHashMap

Es gibt eine besondere Datenstruktur mit dem Namen IdentityHashMap, die statt der internen equals()-Vergleiche einen Identitätsvergleich mit == durchführt. Die Implementierung ist selten im Einsatz, kann aber im Bereich der Performance-Optimierung eine interessante Rolle übernehmen und auch das Problem lösen, wenn in der Map denn absichtlich Objekte enthalten sein sollen, die equals()-gleich sind, aber nicht identisch sind.

11.8.4 Elemente im Assoziativspeicher müssen unveränderbar bleiben 

Ein Hashcode ergibt sich aus den Attributen eines Objekts. Um ein Objekt in einem Assoziativspeicher zu finden, wird dann nach dem Hash-Wert gesucht. Dumm ist, wenn sich dieser in der Zwischenzeit ändert.

Listing 11.15    com/javatutor/insel/util/map/MapImmutable.java(), main()

Map<Point, String> map = new HashMap<Point, String>(); 
Point q = new Point( 10, 10 ); 
map.put( q, "Punkt q" ); 
q.x = 12345; 
System.out.println( map.get( q ) ); // ???

Nach der Zuweisung an x wird hashCode() einen anderen Wert als vorher liefern. Wenn nun get() nach dem Objekt sucht, berechnet es den Hashcode und sucht in den internen Datenstrukturen. Änderte sich der Hashcode jedoch unterdessen, kann das Element nicht mehr gefunden werden und liegt als Leiche in der Map. Daher kann nur davor gewarnt werden, Objektattribute von Objekten, die durch Assoziativspeicher verwaltet werden, nachträglich zu ändern. Das Prinzip Hashing benutzt gerade diese Eigenschaft, um Objekte durch unveränderte Zustände wiederzufinden.

11.8.5 Aufzählen der Elemente 

Eine HashMap kann nicht rechts vom Doppelpunkt vom erweiterten for stehen, da eine Map keine Collection ist und somit kein Iterable implementiert. Eine Map kann jedoch auf drei Arten Collection-Sammlungen zurückgeben:

• keySet() liefert eine Menge der Schlüssel.

• values() liefert eine Collection der Werte.

• entrySet() liefert ein Set mit speziellen Map.Entry-Objekten. Die Map.Entry speichern gleichzeitig den Schlüssel sowie den Wert.

Für die Sammlungen gibt es erst einmal keine definierte Reihenfolge, es sei denn, eine SortedMap wie TreeMap definiert explizit einen Comparator oder die Elemente sind Comparable.

HashMap<String,String> h = new HashMap<String,String>(); 
h.put( "C.Ullenboom", "C.Ullenboom@java-tutor.com" ); 
h.put( "Webmaster", "C.Ullenboom@java-tutor.com" ); 
h.put( "Weihnachtsmann", "Wunsch@weihnachtsmann.com" ); 
h.put( "Christkind", "wunsch@pro-christkind.at" ); 
for ( String elem : h.keySet() ) 
  System.out.println( elem );

Christkind 
Webmaster 
C.Ullenboom 
Weihnachtsmann

Für die Werte ist kein valueSet() möglich, weil ein Wert mehr als einmal vorkommen kann und eine Menge laut Definition einen Wert nicht zweimal enthalten darf. values() liefert die spezielle Collection mit den Werten – iterator() auf dieser Collection bietet dann eine Aufzählung nach Werten. Über den Iterator oder die Collection können Elemente aus der Map gelöscht, aber keine neuen eingefügt werden.

for ( String elem : h.values() ) 
  System.out.println( elem );

wunsch@pro-christkind.at 
C.Ullenboom@java-tutor.com 
C.Ullenboom@java-tutor.com 
Wunsch@weihnachtsmann.com

Während keySet() nur die eindeutigen Schlüssel in einer Menge liefert, gibt entrySet() eine Menge von Objekten vom Typ Map.Entry zurück. Entry ist eine innere Schnittstelle in der Schnittstelle Map, die Schlüssel-Werte-Paare speichert. Die wichtigen Funktionen dieser Schnittstelle sind getKey(), getValue() und setValue(), wobei die letzte Funktion von HashMap angeboten wird, aber eine optionale Funktion ist.

for ( Map.Entry<String, String> e : h.entrySet() ) 
  System.out.println( e.getKey() + "=" + e.getValue() );

interface java.util.Map<K,V>

• Set<K> keySet() Liefert eine Menge mit den Schlüsseln.

• Set<Map.Entry<K,V>> entrySet() Liefert eine Menge von Map.Entry-Objekten, die Zugriff auf die Schlüssel und Werte bieten.

• Collection<V> values() Liefert eine Sammlung der Werte.

Allen Methoden ist gemeinsam, dass sie nur eine andere Sicht auf die Originalmenge darstellen. Wir müssen uns dessen bewusst sein, dass Lösch-Operationen die ursprüngliche Menge verändern.

HashMap<Integer,String> m = new HashMap<Integer,String>(); 
m.put( 1, "Eins" ); 
m.put( 2, "ZZZZZWWWWEEEEEIIII" ); 
 
m.keySet().remove( 2 ); 
 
System.out.println( m );    // {1=Eins}

11.8.6 Der Gleichheitstest, Hash-Wert und Klon einer Hash-Tabelle 

Aus Object stammen die Funktionen equals() und hashCode(), die eine Map wie HashMap beide implementiert. Jede HashMap/TreeMap besitzt zudem eine clone()-Methode, die eine Kopie der Hash-Tabelle erzeugt. Die Kopie bezieht sich allerdings nur auf den Assoziativspeicher selbst; die Schlüssel- und Wert-Objekte teilen sich Original und Klon. Diese Form der Kopie nennt sich auch flache Kopie (engl. shallow copy). Eine Veränderung an den enthaltenen Schlüssel-Werte-Objekten betrifft also immer beide Datenstrukturen, und eine unsachgemäße Modifikation kann zu Unregelmäßigkeiten im Original führen.

interface java.util.Map<K,V>

• boolean equals( Object o ) Damit die Gleichheit von zwei Hash-Tabellen gezeigt werden kann, vergleicht equals() alle Elemente von beiden Tabellen.

• int hashCode() Liefert den Hashcode des Objekts. Das ist wichtig, wenn Sie eine Hash-Tabelle selbst als Schlüssel benutzen wollen – was jedoch als problematisch gelten kann, wenn die Hash-Tabelle später noch verändert werden soll. [Fast schon philosophisch wird’s, wenn eine Hash-Tabelle als Schlüssel oder Wert in sich selbst eingefügt werden soll. Ganz pragmatisch gibt es bei Anfragen einen StackOverflowError, und damit ist die Philosophie am Ende. ]

class java.util.HashMap<K,V> ... 
class java.util.TreeMap<K,V> ...

• Objectclone() Fertigt eine Kopie an, ohne jedoch die Werte selbst zu klonen.

11.8.7 Die Arbeitsweise einer Hash-Tabelle 

Die Hash-Tabelle arbeitet mit Schlüssel-Werte-Paaren. Aus dem Schlüssel wird nach einer Funktion – der so genannten Hash-Funktion – ein Hashcode berechnet. Dieser dient dann als Index für ein internes Array. Dieses Array hat am Anfang eine feste Größe. Wenn später eine Anfrage nach dem Schlüssel gestellt wird, muss einfach diese Berechnung erfolgen, und wir können dann an dieser Stelle nachsehen. Wir können uns eine einfache Hash-Funktion für folgendes Problem denken: Beliebige Zeichenketten sollen in der Hash-Tabelle abgelegt werden. Die Hash-Funktion summiert einfach alle ASCII-Werte der Buchstaben auf und nimmt sie Modulo 77. Dann können in einem Array mit 77 Elementen 77 verschiedene Wörter aufgenommen werden. Leider hat diese Technik einen entscheidenden Nachteil: Denn wenn zwei unterschiedliche Wörter denselben Hashcode besitzen, kommt es zu einer Kollision. Darauf muss die Datenstruktur vorbereitet sein. Hier gibt es verschiedene Lösungsansätze. Die unter Java implementierte Variante benutzt eine verkettete Liste. Falls eine Kollision auftritt, wird der Hashcode beibehalten und der Schlüssel beziehungsweise Wert in einem Listen-Element an den vorhandenen Eintrag angehängt. Eine Sortierung findet nicht statt. Wir merken, dass es auf eine geschickte Wahl der Hash-Funktion ankommt. Denn eine »dumme« Hash-Funktion, die beispielsweise alle Schlüssel nur auf einen Indexwert abbilden würde, erreicht keine Verteilung, sondern lediglich eine lange Liste von Schlüssel-Werte-Paaren. Doch auch bei der besten Verteilung über 77 Elemente ist nach dem Einfügen des 78. Elements irgendwo eine Liste mit mindestens zwei Elementen aufgebaut. Je länger die Listen der miteinander kollidierenden Einträge werden, desto langsamer wird der Zugriff auf die Datenstruktur HashMap und Hashtable.

Um ein Maß für den Füllgrad zu bekommen, wird ein Füllfaktor (Füllgrad) (engl. load factor) eingeführt. Dieser liegt zwischen 0  % und 100  %. Ist er 0  %, so bedeutet dies, dass die Hash-Tabelle leer ist; ist er 100  %, so enthält die Hash-Tabelle genauso viele Einträge, wie das interne Array Elemente umfasst. Die Verteilung der Einträge auf die Array-Elemente wird dabei in der Regel ungleichmäßig sein. Einige Array-Elemente enthalten bereits (kurze) Listen mit kollidierenden Einträgen, während andere Array-Elemente noch unbenutzt sind. Der Füllfaktor einer Hash-Tabelle sollte für einen schnellen Zugriff nicht höher als 75  % sein, das heißt, ein Viertel der Array-Elemente wird grundsätzlich nicht belegt.

Der Füllfaktor und die Konstruktoren

Wir haben oben schon kurz über den Füllfaktor gesprochen. Dieser gibt an, wie »voll« die Hash-Tabelle ist. Es lässt sich nun einstellen, dass die Hash-Tabelle sich automatisch vergrößert, damit der Zugriff wieder schneller wird. Dazu ordnen wir dem Füllgrad einen Prozentwert als Fließkommazahl zwischen 0,0 und 1,0 zu. Ein Wert von 0,75 entspricht also dem oben angesprochenen idealen Füllgrad von 75 Prozent. Es gibt einen Konstruktor für HashMap/Hashtable-Exemplare, der die Angabe eines Füllgrads erlaubt. Ist dieser überschritten, wird die Hash-Tabelle neu berechnet. Dies nennt sich rehash. Dazu wird eine neue Hash-Tabelle angelegt, deren Array größer als das alte ist. Jeder Wert aus der alten Hash-Tabelle wird dabei gemäß der Hash-Funktion an die passende Stelle in das größere Array eingefügt. Ist dies für alle Elemente geschehen, wird die alte Hash-Tabelle gelöscht. Dieses Kopieren und Neuberechnen dauert zwar einige Zeit, doch direkt danach lassen sich die Anfragen an die Datenstruktur wieder schnell beantworten. Wenn die Hash-Tabelle zu oft vergrößert und neu organisiert werden muss, ist dies natürlich ein gewaltiger Geschwindigkeitsnachteil. Doch durch die Vergrößerung wird der Zugriff wieder schneller. Das Rehashen kann nicht ausdrücklich erzwungen werden.

class java.util.HashMap<K,V> 
extends AbstractMap<K,V> 
implements Map<K,V>, Cloneable, Serializable

• HashMap() Die Hash-Tabelle enthält initial eine Kapazität von 16 Einträgen [Unter JDK 1.3 besaß die Hashtable im Standard-Konstruktor 101 Elemente, dann in den frühen 1.4-Versionen 11 Elemente und seit 1.4.1 in einer ganz neuen Implementierung des Hashings 16 Elemente. Üblicherweise nutzen Implementierungen Primzahlen, doch dann kommt es sehr auf die Qualität der Hashfunktionen an, und schlechte Funktionen führen zur Verschlechterung der Laufzeit. Durch die Umstellung bildet nicht mehr die Funktion hashCode() die Elemente direkt auf das interne Feld ab, sondern eine private Hashfunktion, die das Ergebnis von hashCode() nur als einen Parameter sieht. Durch die Umstellung auf eine zweite Funktion sind keine Primzahlen für die Größe des internen Feldes zwingend nötig. ] und einen Füllfaktor von 75  %, also 0,75.

• HashMap( int initialCapacity ) Erzeugt eine Hash-Tabelle mit einer vorgegebenen Kapazität und dem Füllfaktor 0,75.

• HashMap( int initialCapacity, float loadFactor ) Erzeugt eine Hash-Tabelle mit einer vorgegebenen Kapazität und dem angegebenen Füllfaktor.

Die anfängliche Größe des internen Arrays lässt sich in zwei Konstruktoren angeben; ein unsinniger Wert löst eine IllegalArgumentException aus. Zusätzlich kann der Füllfaktor angegeben werden; ist dieser falsch, wird diese Exception ebenfalls ausgelöst. initialCapacity muss größer als die geplante Nutzlast der Hash-Tabelle gewählt werden. Das heißt, bei geplanten 1000 Einträgen etwa 1000 * (1/0,75) = 1333. Ist ein Füllfaktor nicht explizit angegeben, wird die Hash-Tabelle dann vergrößert und neu organisiert, wenn die Anzahl der Einträge in der Hash-Tabelle größer gleich 0,75 × Größe des Arrays ist.